/*
 * Copyright (c) 2008, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package vm.share.options;
import java.lang.annotation.*;
/**
 * This is an auxilary declaration for use with @Factory annotation,
 * allows to add a particular class to the factory.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FClass
{
//    final public static String def_default_value = "[no default]";
    /**
     * A key which tells the BasicObjectFactory to instaniate given class,
     * is mandatory.
     */
    String key(); // mandatory ;
    /**
     * Description of this kind of instances, is mandatory.
     */
    String description();

    /**
     * The class to instantiate, should have a default public constructor,
     * so that type().newInstance() will work, is mandatory.
     */
    Class<?> type();
}
